Total CMS MCPB

Measured conclusion: Deep-tested. L2 outcome: tools_ok.

Connects Claude to Total CMS sites, enabling search, browsing, and management of content via the site's built-in MCP server. Supports both public and authenticated access using an API key stored securely.

Add to your agent

Copy this into your MCP client config:

{
  "mcpServers": {
    "Total CMS MCPB": {
      "url": "https://totalcms.co/mcp",
      "transport": "streamable-http"
    }
  }
}

Measured tools (20)

• describe_collection read-only

  Describe one collection in detail. Returns the collection metadata plus a properties array — each entry is a property with its type, description, and indexed/filterable/sortable flags. Call list_collections first to find a collection id, then describe_collection to see what is queryable inside it. `indexed: true` means the property appears in query_collection / search_collection results (and may be filterable/sortable). `indexed: false` means the property exists on objects but is not returned by query/search — retrieve it through get_object instead.

  Parameters:

  • collection (required) — string — Collection id (slug-form). Use list_collections to discover available collections.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• describe_view read-only

  Describe one data view in detail. Returns metadata (id, name, description, last_built, access, total_items) plus output_shape — the list of keys present on the first cached item, sampled so agents can compose effective query_view / get_view calls. Admin callers also receive the view's Twig definition for dev visibility. Use list_views to discover view ids first.

  Parameters:

  • id (required) — string — View id. Use list_views to discover available views.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• docs_get read-only

  Fetch a full Total CMS documentation page as markdown by its path (as returned by docs_search), e.g. "twig/data" or "site-builder/overview".

  Parameters:

  • path (required) — string — Documentation page path from docs_search results

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• docs_lookup read-only

  Look up a specific Total CMS reference entry: Twig functions/filters, field types, REST API endpoints, schema configuration keys, CLI commands, extension API, or builder API. Omit `name` to list all entries of a kind.

  Parameters:

  • kind (required) — string
  • name — string — Entry name (function name, field type, "GET /api/collections", command name…). Omit to list the kind.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• docs_search read-only

  Search the Total CMS documentation. Returns matching pages with their path, title, group, and section headings. Use docs_get with a returned path to read the full page.

  Parameters:

  • query (required) — string — Search terms, e.g. "image resize twig" or "webhook automation"
  • limit — integer — Maximum results (default 8, max 20)

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• fetch read-only

  Fetch the full document for a search result id. Returns {id, title, text, url, metadata}; `text` is the readable body for citation. Pass an id returned by the `search` tool.

  Parameters:

  • id (required) — string — A document id returned by the `search` tool.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• find_comparison read-only

  Find the head-to-head comparison page for a competitor by name (case-insensitive partial match). Returns the full page content including the feature table. Parameters: - competitor (string, required): Competitor name, e.g. "Kirby" or "Craft". Returns: paginated comparisons objects with url per item.

  Parameters:

  • competitor (required) — string — Competitor name, e.g. "Kirby" or "Craft".

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_object read-only

  Fetch a single object by its id from a collection. Returns the full object as a flat map of fields, decorated with a `url` field where the collection has a public URL pattern configured. This tool does not search or filter — use query_collection for paginated lists or search_collection for free-text search. Available collections and filterable properties: - articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable) - comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable) - extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable) - releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle) - roundups — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), headToHead (toggle), sort (number, sortable), id (id, sortable) - showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)

  Parameters:

  • collection (required) — string — Collection id. Use list_collections to discover available collections.
  • id (required) — string — Object id (slug). Get candidate ids from query_collection or search_collection output.
  • format — string — Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release.
  • locale — string — BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_resource read-only

  Resolve a tcms:// resource URI to its underlying object. Format: tcms://{collection}/{id} — e.g. tcms://blog/hello-world. Equivalent to calling get_object with the parsed collection and id; returns the same shape. Use this when a URI has been surfaced to you (in other tool output, in user input, etc.); use get_object directly when you have a separate collection + id pair. Extension-registered URIs (other schemes) are reachable via the resources/read transport surface.

  Parameters:

  • uri (required) — string — A tcms:// resource URI identifying one object. Format: tcms://{collection}/{id}.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• get_view read-only

  Fetch a data view's full cached result by id. Output is freeform — each item's field set depends on the view's Twig definition. Call describe_view first to learn the expected shape. Capped at 50 items; larger views return the first 50 plus a hint to call query_view for pagination. For per-item paginated access use query_view directly.

  Parameters:

  • id (required) — string — View id. Use list_views to discover available views.
  • format — string — Forward-compat with collection tools. View data is freeform so this has no effect today.
  • locale — string — BCP 47 locale tag — forward-compat for the 3.6 i18n release. No effect today.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• latest_release read-only

  The most recent Total CMS release: version, title, date and the release summary. Returns: paginated releases objects with url per item.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• list_collections read-only

  Discover the collections visible to you. Lean overview — one entry per collection. Returns id, name (display label), schema (the schema id this collection uses), description, url_pattern, access level, and total_objects (so you can decide whether to paginate or enumerate). For the per-property detail of one collection (which properties exist, which are filterable/sortable), call describe_collection. Then query_collection / search_collection / get_object for the data.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• list_guides read-only

  The site's Guides: evergreen buying-guide pages served at /guides/{id}, stored in the roundups collection. Returns every guide in display order with its id, heading, lede, reviewed date and draft flag. A guide's full content (contenders, choose, howToChoose, faqs, sources) is on the object itself: get_object with collection "roundups". Returns: paginated roundups objects with url per item.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• list_views read-only

  Discover the pre-computed data views visible to you. Lean overview — one entry per view. Data views are Twig-defined queries that aggregate across collections; their result is cached and accessible by id. Returns id, name, description, last_built, and access. Use the id with query_view (paginated query), get_view (fetch the whole cached result), or describe_view (output shape + metadata). For raw collection content use list_collections instead.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• needs_review read-only

  Comparison pages ordered by how long ago their competitor facts were last verified, oldest first. Pass `before` (ISO date) to return only pages last verified before that date. Each page shows its verification date publicly, so keeping these fresh matters. Parameters: - before (string, optional): Only pages whose reviewed date is on or before this ISO date (optional). Returns: paginated comparisons objects with url per item.

  Parameters:

  • before — string — Only pages whose reviewed date is on or before this ISO date (optional).

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• query_collection read-only

  Query a collection for paginated content. Returns the matching items plus pagination metadata (total, limit, offset, has_more); each item is decorated with a public `url` field where one is configured. Use REST-style `include` / `exclude` filter strings (comma-separated field:value pairs; AND-semantics for include, OR-semantics for exclude) and `sort` (e.g. `date:desc`). Only properties listed in the catalog below are queryable — other schema properties exist on objects but are not filterable here; use get_object if you need the full record or describe_collection to see every property. This tool does not free-text search content — use search_collection for that. It does not fetch a single object by id — use get_object. Available collections and filterable properties: - articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable) - comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable) - extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable) - releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle) - roundups — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), headToHead (toggle), sort (number, sortable), id (id, sortable) - showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)

  Parameters:

  • collection (required) — string — Collection id (slug-form). Use list_collections to discover available collections.
  • sort — string — Sort rule "field:direction"; multiple rules comma-separated. Only fields marked sortable in the catalog will sort.
  • limit — integer — Maximum items to return. Capped at 50 (vs. REST's 100) to fit MCP response-size budgets.
  • format — string — Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release.
  • locale — string — BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.
  • offset — integer — Number of items to skip — combine with limit for pagination.
  • exclude — string — Comma-separated field:value pairs that exclude items (OR). Drafts the caller may not see are removed before this filter runs, whatever it says.
  • include — string — Comma-separated field:value pairs items must ALL match. Wildcards "*foo*", "foo*", "*foo" supported.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• query_view read-only

  Paginated query against a data view's cached result. REST-syntax include/exclude/sort, same vocabulary as query_collection. View data is freeform — call describe_view first to learn the field set before composing filters. `limit` is capped at 50; use offset to paginate larger views.

  Parameters:

  • id (required) — string — View id from list_views.
  • sort — string — Sort spec, e.g. "date:desc".
  • limit — integer
  • format — string — Forward-compat with query_collection; no effect today since view data is freeform.
  • locale — string — Forward-compat for 3.6 i18n.
  • offset — integer
  • exclude — string — REST-style negative filter.
  • include — string — REST-style filter, e.g. "category:tech,published:true". Field names depend on the view's output shape.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• search read-only

  Search site content across all collections you can see. Returns matching results as {id, title, url}; pass a result id to `fetch` to read the full document. Drafts are hidden from anonymous callers.

  Parameters:

  • query (required) — string — Search terms.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• search_collection read-only

  Free-text search within a single collection. Returns matching items decorated with a public `url`; total reflects what was found. Supports AND (default), OR, and "quoted phrases". Searches across the properties listed in the catalog below — other schema properties exist on objects but are not searchable here; use get_object for the full record or describe_collection to see every property. This tool does not filter by field value — use query_collection with `include`/`exclude` for that. Drafts are auto-hidden from anonymous callers. Available collections and filterable properties: - articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable) - comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable) - extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable) - releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle) - roundups — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), headToHead (toggle), sort (number, sortable), id (id, sortable) - showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)

  Parameters:

  • collection (required) — string — Collection id to search within. Use list_collections to discover available collections.
  • query (required) — string — Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.
  • limit — integer — Maximum items to return (capped at 50 to fit MCP response-size budgets).
  • format — string — Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption.
  • locale — string — BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

• search_collections read-only

  Full-text search across every collection you can see, in one call. Returns matching items each decorated with `collection` (which collection the hit came from) and `url`. Pair `collection` + `id` to fetch the full record via get_object. Call list_collections for the available collections and describe_collection on any one for its full property list; properties not flagged filterable there exist on objects but are not searched here (use get_object for the full record). For a single-collection search use search_collection instead — same query syntax, scoped tighter. Drafts are auto-hidden from anonymous callers.

  Parameters:

  • query (required) — string — Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.
  • limit — integer — Maximum items returned in aggregate across all collections. Capped at 50 for MCP response-size budgets.
  • format — string — Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption.
  • locale — string — BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.

  Hints: read-only yes · destructive no · idempotent yes · open-world no

Repository

Measured by MCPYP probing. Untested fields are omitted, never estimated. Listing is always free; MCPYP never proxies calls or stores user tokens.